Skip to content

assert_config

Pytest Cache Assert Configuration Object.

Attributes⚓︎

Classes⚓︎

AssertConfig ⚓︎

Bases: BaseModel

User configuration data structure.

Source code in pytest_cache_assert/_check_assert/assert_config.py 
class AssertConfig(BaseModel):
    """User configuration data structure."""

    always_write: bool = False
    """Always write to the cached file so that diffs can be examined in the user's VCS."""

    cache_dir_rel_path: str = DEF_CACHE_DIR_NAME
    """String relative directory from `tests/` where default resolves to `tests/assert-cache/`."""

    cache_store: CacheStoreType = Field(default_factory=LocalJSONCacheStore)
    """Configurable class for managing the cache representation. Default is local JSON.

    Override the default `cache_store` to have a custom cache format and serialization

    """

    converters: List[Converter] = Field(default_factory=list)
    """Extend cache_store with custom functions for serializing novel types.

    Example: `[Converter(types=[pd.DataFrame], func=panda_to_json)]` for

    ```py
    def panda_to_json(df: pd.DataFrame) -> List[Dict]:
        return json.loads(df.to_json(orient='records'))
    ```

    Useful for serializing data form pandas or other types that are unknown to the generic converters

    """

    validator: ValidatorType = Field(default_factory=DictDiffValidator)
    """Custom validator for identifying and summarizing the deviations from the cache."""
    model_config = ConfigDict(arbitrary_types_allowed=True)

Attributes⚓︎

always_write class-attribute instance-attribute ⚓︎
always_write: bool = False

Always write to the cached file so that diffs can be examined in the user’s VCS.

cache_dir_rel_path class-attribute instance-attribute ⚓︎
cache_dir_rel_path: str = DEF_CACHE_DIR_NAME

String relative directory from tests/ where default resolves to tests/assert-cache/.

cache_store class-attribute instance-attribute ⚓︎
cache_store: CacheStoreType = Field(default_factory=LocalJSONCacheStore)

Configurable class for managing the cache representation. Default is local JSON.

Override the default cache_store to have a custom cache format and serialization

converters class-attribute instance-attribute ⚓︎
converters: List[Converter] = Field(default_factory=list)

Extend cache_store with custom functions for serializing novel types.

Example: [Converter(types=[pd.DataFrame], func=panda_to_json)] for

def panda_to_json(df: pd.DataFrame) -> List[Dict]:
    return json.loads(df.to_json(orient='records'))

Useful for serializing data form pandas or other types that are unknown to the generic converters

validator class-attribute instance-attribute ⚓︎
validator: ValidatorType = Field(default_factory=DictDiffValidator)

Custom validator for identifying and summarizing the deviations from the cache.

Last update: August 30, 2023
Created: August 30, 2023